GET api/clients/{clientId}/attachments?fileIds[0]={fileIds[0]}&fileIds[1]={fileIds[1]}&includeContent={includeContent}
Gets attachments for client
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
Client Id to get attachments against |
integer |
Required |
| fileIds |
File ids to filter to only provided file ids |
Collection of integer |
None. |
| includeContent |
Include/Exclude binary content of file |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Returns
Collection of Attachment| Name | Description | Type | Additional information |
|---|---|---|---|
| FileId |
Gets or sets file id |
integer |
None. |
| Name |
Gets or sets file name |
string |
None. |
| FileType |
Gets or sets file type |
string |
None. |
| FileSize |
Gets or sets file size |
unsigned integer |
None. |
| FileData |
Gets or sets file binary data |
string |
None. |
| Description |
Gets or sets file description |
string |
None. |
| FileMark |
Gets or sets the File Mark |
FileMark |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"fileId": 1,
"name": "sample string 2",
"fileType": "sample string 3",
"fileSize": 1,
"fileData": "sample string 4",
"description": "sample string 5",
"fileMark": 0
},
{
"fileId": 1,
"name": "sample string 2",
"fileType": "sample string 3",
"fileSize": 1,
"fileData": "sample string 4",
"description": "sample string 5",
"fileMark": 0
}
]
application/xml, text/xml
Sample:
<ArrayOfAttachment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
<Attachment>
<Description>sample string 5</Description>
<FileData>sample string 4</FileData>
<FileId>1</FileId>
<FileMark>MarkedAsOriginal</FileMark>
<FileSize>1</FileSize>
<FileType>sample string 3</FileType>
<Name>sample string 2</Name>
</Attachment>
<Attachment>
<Description>sample string 5</Description>
<FileData>sample string 4</FileData>
<FileId>1</FileId>
<FileMark>MarkedAsOriginal</FileMark>
<FileSize>1</FileSize>
<FileType>sample string 3</FileType>
<Name>sample string 2</Name>
</Attachment>
</ArrayOfAttachment>